|
|
PBHGetVolParmsAsync |
||||
| Header: | Files.h | Carbon status: | Supported | |
Returns information about the characteristics of a volume.
OSErr PBHGetVolParmsAsync (
HParmBlkPtr paramBlock
);
A pointer to a parameter block.
A result code.
The relevant fields of the parameter block are:
On input, a pointer to a completion routine.
On output, the result code of the function
On input, a pointer to the volume’s name. If you use a volume specification to specify the volume, you should set the ioNamePtr field to NULL.
On input, a volume specification. A volume specification can be a volume reference number, drive number, or working directory reference number.
On input, you must allocate memory to hold the returned attributes and put a pointer to the GetVolParmsInfoBuffer record in this field. On return, the PBHGetVolParmsAsync function places the attributes information in the buffer
Volumes that implement the HFS Plus APIs must use the version 3 (or newer) of the GetVolParmsInfoBuffer structure. If the version of the GetVolParmsInfoBuffer is 2 or less, or the bSupportsHFSPlusAPIs bit is clear, then the volume does not implement the HFS Plus APIs and they are being emulated for that volume by the File Manager.
On input, the size, in bytes, of the buffer area pointed to in the ioBuffer field.
On output, the size of the data actually returned.
You specify a volume (either by name or by volume reference number) and a buffer size, and PBHGetVolParmsAsync fills in the volume attributes buffer. You can use a name (pointed to by the ioNamePtr field) or a volume specification (contained in the ioVRefNum field) to specify the volume.
Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.
© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)